home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cptsvx.z / cptsvx
Text File  |  1996-03-14  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CPTSVX - use the factorization A = L*D*L**H to compute the solution to a
  10.      complex system of linear equations A*X = B, where A is an N-by-N
  11.      Hermitian positive definite tridiagonal matrix and X and B are N-by-NRHS
  12.      matrices
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      SUBROUTINE CPTSVX( FACT, N, NRHS, D, E, DF, EF, B, LDB, X, LDX, RCOND,
  16.                         FERR, BERR, WORK, RWORK, INFO )
  17.  
  18.          CHARACTER      FACT
  19.  
  20.          INTEGER        INFO, LDB, LDX, N, NRHS
  21.  
  22.          REAL           RCOND
  23.  
  24.          REAL           BERR( * ), D( * ), DF( * ), FERR( * ), RWORK( * )
  25.  
  26.          COMPLEX        B( LDB, * ), E( * ), EF( * ), WORK( * ), X( LDX, * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      CPTSVX uses the factorization A = L*D*L**H to compute the solution to a
  30.      complex system of linear equations A*X = B, where A is an N-by-N
  31.      Hermitian positive definite tridiagonal matrix and X and B are N-by-NRHS
  32.      matrices.
  33.  
  34.      Error bounds on the solution and a condition estimate are also provided.
  35.  
  36.  
  37. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.      The following steps are performed:
  39.  
  40.      1. If FACT = 'N', the matrix A is factored as A = L*D*L**H, where L
  41.         is a unit lower bidiagonal matrix and D is diagonal.  The
  42.         factorization can also be regarded as having the form
  43.         A = U**H*D*U.
  44.  
  45.      2. The factored form of A is used to compute the condition number
  46.         of the matrix A.  If the reciprocal of the condition number is
  47.         less than machine precision, steps 3 and 4 are skipped.
  48.  
  49.      3. The system of equations is solved for X using the factored form
  50.         of A.
  51.  
  52.      4. Iterative refinement is applied to improve the computed solution
  53.         matrix and calculate error bounds and backward error estimates
  54.         for it.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74. ARGUMENTS
  75.      FACT    (input) CHARACTER*1
  76.              Specifies whether or not the factored form of the matrix A is
  77.              supplied on entry.  = 'F':  On entry, DF and EF contain the
  78.              factored form of A.  D, E, DF, and EF will not be modified.  =
  79.              'N':  The matrix A will be copied to DF and EF and factored.
  80.  
  81.      N       (input) INTEGER
  82.              The order of the matrix A.  N >= 0.
  83.  
  84.      NRHS    (input) INTEGER
  85.              The number of right hand sides, i.e., the number of columns of
  86.              the matrices B and X.  NRHS >= 0.
  87.  
  88.      D       (input) REAL array, dimension (N)
  89.              The n diagonal elements of the tridiagonal matrix A.
  90.  
  91.      E       (input) COMPLEX array, dimension (N-1)
  92.              The (n-1) subdiagonal elements of the tridiagonal matrix A.
  93.  
  94.      DF      (input or output) REAL array, dimension (N)
  95.              If FACT = 'F', then DF is an input argument and on entry contains
  96.              the n diagonal elements of the diagonal matrix D from the
  97.              L*D*L**H factorization of A.  If FACT = 'N', then DF is an output
  98.              argument and on exit contains the n diagonal elements of the
  99.              diagonal matrix D from the L*D*L**H factorization of A.
  100.  
  101.      EF      (input or output) COMPLEX array, dimension (N-1)
  102.              If FACT = 'F', then EF is an input argument and on entry contains
  103.              the (n-1) subdiagonal elements of the unit bidiagonal factor L
  104.              from the L*D*L**H factorization of A.  If FACT = 'N', then EF is
  105.              an output argument and on exit contains the (n-1) subdiagonal
  106.              elements of the unit bidiagonal factor L from the L*D*L**H
  107.              factorization of A.
  108.  
  109.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  110.              The N-by-NRHS right hand side matrix B.
  111.  
  112.      LDB     (input) INTEGER
  113.              The leading dimension of the array B.  LDB >= max(1,N).
  114.  
  115.      X       (output) COMPLEX array, dimension (LDX,NRHS)
  116.              If INFO = 0, the N-by-NRHS solution matrix X.
  117.  
  118.      LDX     (input) INTEGER
  119.              The leading dimension of the array X.  LDX >= max(1,N).
  120.  
  121.      RCOND   (output) REAL
  122.              The reciprocal condition number of the matrix A.  If RCOND is
  123.              less than the machine precision (in particular, if RCOND = 0),
  124.              the matrix is singular to working precision.  This condition is
  125.              indicated by a return code of INFO > 0, and the solution and
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))                                                          CCCCPPPPTTTTSSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              error bounds are not computed.
  141.  
  142.      FERR    (output) REAL array, dimension (NRHS)
  143.              The forward error bound for each solution vector X(j) (the j-th
  144.              column of the solution matrix X).  If XTRUE is the true solution
  145.              corresponding to X(j), FERR(j) is an estimated upper bound for
  146.              the magnitude of the largest element in (X(j) - XTRUE) divided by
  147.              the magnitude of the largest element in X(j).
  148.  
  149.      BERR    (output) REAL array, dimension (NRHS)
  150.              The componentwise relative backward error of each solution vector
  151.              X(j) (i.e., the smallest relative change in any element of A or B
  152.              that makes X(j) an exact solution).
  153.  
  154.      WORK    (workspace) COMPLEX array, dimension (N)
  155.  
  156.      RWORK   (workspace) REAL array, dimension (N)
  157.  
  158.      INFO    (output) INTEGER
  159.              = 0:  successful exit
  160.              < 0:  if INFO = -i, the i-th argument had an illegal value
  161.              > 0:  if INFO = i, and i is <= N  the leading minor of order i of
  162.              A is not positive definite, so the factorization could not be
  163.              completed unless i = N, and the solution and error bounds could
  164.              not be computed.  = N+1 RCOND is less than machine precision.
  165.              The factorization has been completed, but the matrix is singular
  166.              to working precision, and the solution and error bounds have not
  167.              been computed.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.